ParcelPickUp API
Environments and Testing
Overview
You, as an integrating partner, are expected to maintain your own development, test and production environments from which to call the corresponding NZ Post Group environment and to follow the software development lifecycle as below:
Environment Detail
| Name | Use | Addresses |
|---|---|---|
| NZ Post Group User Acceptance Test (UAT) Environment | This environment is available for integration to test customer’s solutions to ensure that calls to the API’s are technically correct and that the responses received are handled as they expect. This environment is available for system, integration and user acceptance testing. | https://api.uat.nzpost.co.nz/parcelpickup/v3/bookings |
| Production Environment | This environment is for live use and is only available to integrators upon completion of the go-live checklist. | https://api.nzpost.co.nz/parcelpickup/v3/bookings |
Testing Your Application
NZ Post Group is committed to making integration to its products easy and robust and are available to support your development and testing.
As with any development, NZ Post Group encourages you to test your application with both positive and negative scenarios. The following list of test cases has been provided for your convenience but it is not intended to be comprehensive. Some test cases may not apply to your use of the API. Please extend with test cases specific to your business.
Note: All testing should be conducted in the UAT environment provided. If tests are executed against the production environment, eg to confirm the success of a production release, please prefix all pick up and delivery address fields with the word "TEST" as the test will otherwise produce a pick up request and a courier will be despatched to the pick up address.
| Suggested Test Cases | Expected Result |
|---|---|
| Create pick up request where Pace is the carrier | Success message received |
| Create pick up request where CourierPost is the carrier | Success message received |
| Create pick up request for multiple parcels | Success message received |